Credit Transfer Outbound

The Transfer API enables to initiate outbound transactions.

Method: POST

{{URL}}/rtp/rpc/TransactionService/Transfer

Headers

Name	Value
Content-Type	application/json
Credential	"Basic c3VwcG9ydCsxQG5ldHN5cy1pbmMuY29tOjM5ZDYxOGJkNTVmN5NWQxY2RlNDE5"
Signature	"{{signature}}"

Example

Payload Parameters

Parameter	Description
referenceNumber Mandatory	String Reference number of the transaction Example – "M202311099876665149078836456"
processor Mandatory	String Payment channel through which the transaction happens Example – "TCH" or "FedNow"
SenderType Mandatory (applicable only for TCH)	String Type of customer Example – "CONSUMER"
instructedAmount Mandatory	Object
amount Mandatory	Number Amount of transaction Example – 8546
currency Mandatory	String Currency code in which the transaction happens Example – "USD"
creditorAccount Mandatory	Object
memberId Mandatory	String Routing numer of the beneficiary bank/financial institution Example – "234567891"
name Mandatory	String Name of the beneficiary Example – "Test"
accountNumber Mandatory	String Account number of the beneficiary Example – "99664715164441"
address Optional	Object
streetName Optional	String Street name of the beneficiary address Example – "sdsds"
postalCode Optional	String Postal code of the beneficiary address Example – "1245"
townName Optional	String Town name of the beneficiary address Example – "Chicago"
countrySubDiv Optional	String Code of a subdivision which can be a state, province, or region Example – "OL"
country Optional	String Country code of the beneficiary address Example – "LM"
debtorAccount Optional	Object
memberId Optional	String Routing numer of the sender bank/financial institution Example – "026013673"
name Optional	String Name of the sender Example – "sgdgsd"
accountNumber Optional	String Account number of the sender Example – "4234242423"
address Optional	Object
streetName Optional	String Street name of the sender address Example – "124a"
postalCode Optional	String Postal code of the sender address Example – "1245"
townName Optional	String Town name of the sender address Example – "LosAngeles"
countrySubDiv Optional	String Code of a subdivision which can be a state, province, or region Example – "IN"
country Optional	String Country code of the sender address Example – "US"

cURL

curl --location '{{URL}}/rtp/rpc/TransactionService/Transfer' \
--header 'Content-Type: application/json' \
--data '{"referenceNumber":"M202311099876665149078836456","processor":"TCH","SenderType":"CONSUMER","instructedAmount":{"amount":8546,"currency":"USD"},"creditorAccount":{"memberId":"234567891","name":"Test","accountNumber":"99664715164441","address":{"streetName":"sdsds","postalCode":"1245","townName":"Chicago","countrySubDiv":"LM","country":"US"}},"debtorAccount":{"memberId":"026013673","name":"sgdgsd","accountNumber":"4234242423","address":{"streetName":"124a","postalCode":"1245","townName":"LosAngeles","countrySubDiv":"IN","country":"US"}}}'

C#

var options = new RestClientOptions("{{URL}}")
{
  MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("/rtp/rpc/TransactionService/Transfer", Method.Post);
request.AddHeader("Content-Type", "application/json");
var body = @"{
" + "\n" +
@"    ""referenceNumber"": ""M202311099876665149078836456"",
" + "\n" +
@"    ""processor"": ""TCH"",
" + "\n" +
@"    ""SenderType"": ""CONSUMER"",
" + "\n" +
@"    ""instructedAmount"": {
" + "\n" +
@"        ""amount"": 8546,
" + "\n" +
@"        ""currency"": ""USD""
" + "\n" +
@"    },
" + "\n" +
@"    ""creditorAccount"": {
" + "\n" +
@"        ""memberId"": ""234567891"",
" + "\n" +
@"        ""name"": ""Test"",
" + "\n" +
@"        ""accountNumber"": ""99664715164441"",
" + "\n" +
@"        ""address"": {
" + "\n" +
@"            ""streetName"": ""sdsds"",
" + "\n" +
@"            ""postalCode"": ""1245"",
" + "\n" +
@"            ""townName"": ""Chicago"",
" + "\n" +
@"            ""countrySubDiv"": ""LM"",
" + "\n" +
@"            ""country"": ""US""
" + "\n" +
@"        }
" + "\n" +
@"    },
" + "\n" +
@"    ""debtorAccount"": {
" + "\n" +
@"        ""memberId"": ""026013673"",
" + "\n" +
@"        ""name"": ""sgdgsd"",
" + "\n" +
@"        ""accountNumber"": ""4234242423"",
" + "\n" +
@"        ""address"": {
" + "\n" +
@"            ""streetName"": ""124a"",
" + "\n" +
@"            ""postalCode"": ""1245"",
" + "\n" +
@"            ""townName"": ""LosAngeles"",
" + "\n" +
@"            ""countrySubDiv"": ""IN"",
" + "\n" +
@"            ""country"": ""US""
" + "\n" +
@"        }
" + "\n" +
@"    }
" + "\n" +
@"}";
request.AddStringBody(body, DataFormat.Json);
RestResponse response = await client.ExecuteAsync(request);
Console.WriteLine(response.Content);

Go

package main

import (
  "fmt"
  "strings"
  "net/http"
  "io/ioutil"
)

func main() {

  url := "{{URL}}/rtp/rpc/TransactionService/Transfer"
  method := "POST"

  payload := strings.NewReader(`{`+"
"+`
    "referenceNumber": "M202311099876665149078836456",`+"
"+`
    "processor": "TCH",`+"
"+`
    "SenderType": "CONSUMER",`+"
"+`
    "instructedAmount": {`+"
"+`
        "amount": 8546,`+"
"+`
        "currency": "USD"`+"
"+`
    },`+"
"+`
    "creditorAccount": {`+"
"+`
        "memberId": "234567891",`+"
"+`
        "name": "Test",`+"
"+`
        "accountNumber": "99664715164441",`+"
"+`
        "address": {`+"
"+`
            "streetName": "sdsds",`+"
"+`
            "postalCode": "1245",`+"
"+`
            "townName": "Chicago",`+"
"+`
            "countrySubDiv": "LM",`+"
"+`
            "country": "US"`+"
"+`
        }`+"
"+`
    },`+"
"+`
    "debtorAccount": {`+"
"+`
        "memberId": "026013673",`+"
"+`
        "name": "sgdgsd",`+"
"+`
        "accountNumber": "4234242423",`+"
"+`
        "address": {`+"
"+`
            "streetName": "124a",`+"
"+`
            "postalCode": "1245",`+"
"+`
            "townName": "LosAngeles",`+"
"+`
            "countrySubDiv": "IN",`+"
"+`
            "country": "US"`+"
"+`
        }`+"
"+`
    }`+"
"+`
}`)

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, payload)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Content-Type", "application/json")

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := ioutil.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}

NodeJs

var https = require('follow-redirects').https;
var fs = require('fs');

var options = {
  'method': 'POST',
  'hostname': '{{URL}}',
  'path': '/rtp/rpc/TransactionService/Transfer',
  'headers': {
    'Content-Type': 'application/json'
  },
  'maxRedirects': 20
};

var req = https.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function (chunk) {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });

  res.on("error", function (error) {
    console.error(error);
  });
});

var postData = JSON.stringify({
  "referenceNumber": "M202311099876665149078836456",
  "processor": "TCH",
  "SenderType": "CONSUMER",
  "instructedAmount": {
    "amount": 8546,
    "currency": "USD"
  },
  "creditorAccount": {
    "memberId": "234567891",
    "name": "Test",
    "accountNumber": "99664715164441",
    "address": {
      "streetName": "sdsds",
      "postalCode": "1245",
      "townName": "Chicago",
      "countrySubDiv": "LM",
      "country": "US"
    }
  },
  "debtorAccount": {
    "memberId": "026013673",
    "name": "sgdgsd",
    "accountNumber": "4234242423",
    "address": {
      "streetName": "124a",
      "postalCode": "1245",
      "townName": "LosAngeles",
      "countrySubDiv": "IN",
      "country": "US"
    }
  }
});

req.write(postData);

req.end();

Request Body (Applicable for both FedNow and TCH)

{
    "referenceNumber": "M202311099876665149078836456",
    "processor": "TCH",
    "SenderType": "CONSUMER", //applicable only for TCH
    "instructedAmount": {
        "amount": 8546,
        "currency": "USD"
    },
    "creditorAccount": {
        "memberId": "234567891",
        "name": "Test",
        "accountNumber": "99664715164441",
        "address": {
            "streetName": "sdsds",
            "postalCode": "1245",
            "townName": "Chicago",
            "countrySubDiv": "LM",
            "country": "US"
        }
    },
    "debtorAccount": {
        "memberId": "026013673",
        "name": "sgdgsd",
        "accountNumber": "4234242423",
        "address": {
            "streetName": "124a",
            "postalCode": "1245",
            "townName": "LosAngeles",
            "countrySubDiv": "IN",
            "country": "US"
        }
    }
}

Response: 200

Response Parameters

Parameter	Description
response	String Response received for the given request Example – "JSON Representation of Received Response"
message	String Notification message for the transaction Example – "Transfered Successfully"
transactionID	String Unique ID generated for the transaction Example – "20240328026013673T1B6ZQQ99286072611"
endToEndId	String ID that enables to trace the transaction at any time during the process Example – "M202311099876665149078836457"
instructingId	String Payment reference ID of the transaction Example – "20240328026013673T1B6ZQQ99286072611"
messageId	String Unique message ID generated for the transaction Example – "M20240328026013673T1BPQG99286072611"
rawMessage	String Raw response message related to the transaction encoded in Base64 Example – "Base64 Value of Received Response"
status	String Current status of the transaction Example – "ACTC"
acceptedDate	String Date and time of the transaction was processed Example – "2024-03-28T11:57:48"
settlementDate	String Date and time of the transaction was completed Example – "2024-03-28"
windowId (applicable only for TCH)	String Unique ID used for reconciliation of transactions Example – "001"

Response Body (Applicable for both FedNow and TCH)

{
  "response": "JSON Representation of Received Response",
  "message": "Transfered Successfully",
  "transactionID": "20240328026013673T1B6ZQQ99286072611",
  "endToEndId": "M202311099876665149078836457",
  "instructingId": "20240328026013673T1B6ZQQ99286072611",
  "messageId": "M20240328026013673T1BPQG99286072611",
  "rawMessage": "Base64 Value of Received Response",
  "status": "ACTC",
  "acceptedDate": "2024-03-28T11:57:48",
  "settlementDate": "2024-03-28",
  "windowId": "001" //applicable only for TCH
}